org.eclipse.vtp.framework.common.configurations
Class DispatchConfiguration

java.lang.Object
  org.eclipse.vtp.framework.common.configurations.DispatchConfiguration

All Implemented Interfaces:

CommonConstants, IConfiguration

public class DispatchConfiguration
extends java.lang.Object
implements IConfiguration, CommonConstants

A single configuration for forwarding to or including another process.

Author:

Lonnie Pryor

Field Summary

Fields inherited from interface org.eclipse.vtp.framework.common.configurations.CommonConstants

MAPPING_TYPE_EXPRESSION, MAPPING_TYPE_NONE, MAPPING_TYPE_STATIC, MAPPING_TYPE_VARIABLE, NAME_ASSIGNMENT, NAME_BRANCH, NAME_BRAND, NAME_DATA_TYPE, NAME_DISPATCH, NAME_ENTRY, NAME_EXIT, NAME_FIELD, NAME_INITIAL_VALUE, NAME_KEY, NAME_LEFT_OPERAND, NAME_NAME, NAME_OUTGOING, NAME_PATH, NAME_PRIMARY_FIELD, NAME_RIGHT_OPERAND, NAME_SCRIPT, NAME_SCRIPTING_LANGUGAGE, NAME_TYPE, NAME_URI, NAME_VALUE, NAME_VARIABLE_MAPPING, NAMESPACE_URI

Constructor Summary

DispatchConfiguration()
Creates a new DispatchItemConfiguration.

Method Summary

void	clear() Clears all the currently configured information in this item.
java.lang.String[]	getOutgoingDataNames(java.lang.String path)
java.lang.String	getOutgoingDataValue(java.lang.String path, java.lang.String name)
java.lang.String[]	getOutgoingPaths()
java.lang.String	getTargetProcessURI() Returns the URI of the process to dispatch to.
VariableMappingConfiguration	getVariableMapping(java.lang.String variableName) Returns the configuration for the specified variable in the target process.
java.lang.String[]	getVariableNames() Returns the names of the variables that will be initialized in the target process.
void	load(org.w3c.dom.Element configurationElement) Loads the configuration information from the specified XML element.
void	save(org.w3c.dom.Element configurationElement) Saves the configuration information into the supplied XML element.
void	setOutgoingDataValue(java.lang.String path, java.lang.String name, java.lang.String value)
void	setTargetProcessURI(java.lang.String destinationURI) Sets the URI of the process to dispatch to.
void	setVariableMapping(java.lang.String variableName, VariableMappingConfiguration variableMapping) Sets the configuration for the specified variable in the target process.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DispatchConfiguration

public DispatchConfiguration()

Creates a new DispatchItemConfiguration.

Method Detail

getTargetProcessURI

public java.lang.String getTargetProcessURI()

Returns the URI of the process to dispatch to.

Returns:

The URI of the process to dispatch to.

setTargetProcessURI

public void setTargetProcessURI(java.lang.String destinationURI)

Sets the URI of the process to dispatch to.

Parameters:

destinationURI - The URI of the process to dispatch to.

getVariableNames

public java.lang.String[] getVariableNames()

Returns the names of the variables that will be initialized in the target process.

Returns:

The names of the variables that will be initialized in the target process.

getVariableMapping

public VariableMappingConfiguration getVariableMapping(java.lang.String variableName)

Returns the configuration for the specified variable in the target process.

Parameters:

variableName - The name of the variable in the target process to configure.

Returns:

The configuration for the specified variable in the target process.

setVariableMapping

public void setVariableMapping(java.lang.String variableName,
                               VariableMappingConfiguration variableMapping)

Sets the configuration for the specified variable in the target process.

Parameters:

variableName - The name of the variable in the target process.

variableMapping - The configuration for the specified variable in the target process.

getOutgoingPaths

public java.lang.String[] getOutgoingPaths()

getOutgoingDataNames

public java.lang.String[] getOutgoingDataNames(java.lang.String path)

getOutgoingDataValue

public java.lang.String getOutgoingDataValue(java.lang.String path,
                                             java.lang.String name)

setOutgoingDataValue

public void setOutgoingDataValue(java.lang.String path,
                                 java.lang.String name,
                                 java.lang.String value)

clear

public void clear()

Clears all the currently configured information in this item.

load

public void load(org.w3c.dom.Element configurationElement)

Description copied from interface: IConfiguration

Loads the configuration information from the specified XML element.

Specified by:

load in interface IConfiguration

Parameters:

configurationElement - The element to load the configuration from.

save

public void save(org.w3c.dom.Element configurationElement)

Description copied from interface: IConfiguration

Saves the configuration information into the supplied XML element.

Specified by:

save in interface IConfiguration

Parameters:

configurationElement - The element to save the configuration to.